home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1510.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  2.3 KB  |  105 lines
  1. 117
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. XDelete 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baXDelete deletes files with wildcard matching, including sub-directories.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baXDelete( DirName , FileSpec )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. String, string. 
  36. --- RECORDSEPARATOR ---
  37. DirName is the folder to delete the files from. 
  38. --- RECORDSEPARATOR ---
  39. FileSpec determines what files are deleted.
  40. --- RECORDSEPARATOR ---
  41.  
  42. --- RECORDSEPARATOR ---
  43. Returns:
  44. --- RECORDSEPARATOR ---
  45.  
  46. --- RECORDSEPARATOR ---
  47. Integer. 
  48. --- RECORDSEPARATOR ---
  49. Returns 1 if all the matching files were successfully deleted or if DirName doesn't 
  50. --- RECORDSEPARATOR ---
  51. exist, else 0.
  52. --- RECORDSEPARATOR ---
  53.  
  54. --- RECORDSEPARATOR ---
  55. Examples:
  56. --- RECORDSEPARATOR ---
  57.  
  58. --- RECORDSEPARATOR ---
  59. Director: 
  60. --- RECORDSEPARATOR ---
  61. set OK = baXDelete( "c:\data" , "*.bak" ) 
  62. --- RECORDSEPARATOR ---
  63. set OK = baXDelete( ΓÇ£Mac HD:data" , "TEXT" ) 
  64. --- RECORDSEPARATOR ---
  65. Authorware: 
  66. --- RECORDSEPARATOR ---
  67. OK := baXDelete( "c:\\data , "*.bak" )
  68. --- RECORDSEPARATOR ---
  69.  
  70. --- RECORDSEPARATOR ---
  71. Notes:
  72. --- RECORDSEPARATOR ---
  73.  
  74. --- RECORDSEPARATOR ---
  75. Any empty directories that are left will also be deleted. 
  76. --- RECORDSEPARATOR ---
  77. On
  78. --- RECORDSEPARATOR ---
  79.  Windows
  80. --- RECORDSEPARATOR ---
  81. , the FileSpec argument follows normal DOS wildcard rules. A * 
  82. --- RECORDSEPARATOR ---
  83. means match any character in the file name. So *.* deletes all files in the directory; 
  84. --- RECORDSEPARATOR ---
  85. *.bmp deletes all files with a .bmp extension; T*.* deletes all files starting with the 
  86. --- RECORDSEPARATOR ---
  87. letter T. 
  88. --- RECORDSEPARATOR ---
  89. On
  90. --- RECORDSEPARATOR ---
  91.  Macintosh
  92. --- RECORDSEPARATOR ---
  93. , the wildcard is the four character type code, eg ΓÇ£TEXTΓÇ¥. Only one 
  94. --- RECORDSEPARATOR ---
  95. type can be specified. Use an empty string or ΓÇ£*.*ΓÇ¥ to specify all files.
  96. --- RECORDSEPARATOR ---
  97.  
  98. --- RECORDSEPARATOR ---
  99. See also:
  100. --- RECORDSEPARATOR ---
  101.  
  102. --- RECORDSEPARATOR ---
  103. baDeleteFile 
  104. --- RECORDSEPARATOR ---
  105. baDeleteXFiles